home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2002 #3 / Amiga Plus CD - 2002 - No. 03.iso / AmigaPlus / Tools / Development / envCPP31 / c++ / tools / gnu-indent / docs / NEWS < prev    next >
Encoding:
Text File  |  2002-01-01  |  19.5 KB  |  577 lines
  1. Release notes for GNU indent version 2.2.6, November 2000
  2.  
  3. * New option --break-function-decl-args (-bfda).
  4.   This causes each argument of a function declaration to be put on
  5.   a seperate line, aligned with the opening parathesis of the function.
  6.   For example,
  7.  
  8.   void
  9.   udi_pio_trans(udi_pio_trans_call_t *callback,
  10.                 udi_cb_t *gcb,
  11.         udi_pio_handle_t handle,
  12.         udi_buf_t *buf,
  13.         void *mem_ptr)
  14.  
  15. * The option -diN does not any longer indent procedure names
  16.   (when also using -npsl).  Nested function are still indented however.
  17.  
  18. * New options --no-space-after-for (-nsaf), --no-space-after-if (-nsai)
  19.   and --no-space-after-while (-nsaw) to remove the space directly following
  20.   `for', `if' and `while' respectively.
  21.  
  22. * Nested functions (a gcc extension) were indented wrong.
  23.  
  24. * --blank-lines-after-declarations (-bad) caused blank lines to be
  25.   inserted in the middle of C-style comments when a multiple line
  26.   comment was used after a declaration.
  27.  
  28. * The option --dont-line-up-parentheses (-nlp) was broken, sometimes
  29.   causing long lines that were broken twice or more being indented
  30.   too little.
  31.  
  32. * Renamed long option --blank-lines-after-block-comments to
  33.   --blank-lines-before-block-comments.  This was a very old bug.
  34.   The equivalent short option is still -bbb.
  35.   Idem for --no-blank-lines-after-block-comments.
  36.  
  37. * New option --cuddle-do-while (-cdw).
  38.   This causes the `while' in a do-while loop to cuddle up to the
  39.   immediately preceding `}'.  For example,
  40.   
  41.   do {
  42.     x--;
  43.   } while (x);
  44.  
  45. * New option --no-tabs (-nut) causes indent to replace all TABS with
  46.   the appropriate space in the output.  Unlike using --tab-size 1,
  47.   this has no influence on the column where comments start.
  48.  
  49. * --line-comments-indentationN/-dN now works again.
  50.  
  51. * Sometimes an extra blank line was inserted between two parts of a
  52.   long, broken line.  This should be fixed now.
  53.  
  54. * The priority of breaking lines at a point that doesn't help, is now
  55.   set at minus infinity.  The means that instead of getting
  56.  
  57.   if (
  58.       extremely_long.
  59.       struct_element)
  60.  
  61.   because breaking after a '.' has a very low priority, you'll now get
  62.  
  63.   if (extremely_long.
  64.       struct_element)
  65.  
  66. * The option --format-comments (-fca) was broken, it did not remove leading
  67.   '*' in comments like: "/* this       , this now becomes: "/* this <- one */".
  68.                           * <- one */"   instead of "/* this * <- one */".
  69.   Adjacent spaces are now always eaten and not only when they are at the
  70.   start of a line: "/* a  b.    c  d */" becomes now "/* a b.  c d */".
  71.   Two spaces are left after a dot.
  72.  
  73. * A typo in indent.c caused types inside a sizeof() to be marked as a
  74.   declaration.  This caused a blank line to be put after them in some
  75.   cases (when using the --blank-lines-after-declarations (-bad)).
  76.  
  77. * A backslash-newline, outside a macro definition or string, was treated
  78.   as two seperate characters, breaking compilation when the newline was
  79.   repositioned.  Now the backslash is simply eaten.
  80.  
  81. Release notes for GNU indent version 2.2.5, Januari 2000
  82.  
  83. * When using --dont-break-procedure-type, indent wrongly joined
  84.   lines of a procedure declaration ending in a '(' and followed
  85.   by a comment.  In the case of a C++-style comment that even
  86.   broke compilation.
  87.  
  88.   int func( /* hello */
  89.     char c)
  90.   {
  91.  
  92.   became
  93.  
  94.   int func( /* hello */ char c)
  95.   {
  96.  
  97. * Added missing README.VMS to tar ball.  Added support for VMS'
  98.   DECC compiler. (Patch by forrest.cahoon@merrillcorp.com).
  99.  
  100. * New option --space-after-parentheses (-prs) causes parentheses
  101.   to be printed with spaces: if ( foo( i + 1 ) == 1 ).
  102.  
  103. * --braces-on-if-line (-br) caused indentation of statements
  104.   after case: label to be indented wrongly (not relative to the
  105.   start of the case: label).  This fix means that when you use -br
  106.   together with -cliN where N is not 0, then your code will change:
  107.   subtract the value for -cli from -cbi to get the same results
  108.   for { braced } case statements.
  109.  
  110.   The correct meaning when using -br is now:
  111.  
  112.   switch (i) {
  113.   <--cliN-->case x:
  114.             <--iN-->statement;
  115.   <--cliN-->case y:
  116.             <--cbiN-->{
  117.                       <--iN-->statement;
  118.  
  119.   Without -br it still is:
  120.  
  121.   switch (i)
  122.   <--bliN-->{
  123.             <--cliN-->case x:
  124.                       <--iN-->statement;
  125.             <--cliN-->case y:
  126.                       <--cbiN-->{
  127.                                 <--iN-->statement;
  128.  
  129. * Indentation options now accept negative values for greater flexibility.
  130.  
  131. Release notes for GNU indent version 2.2.4, November 1999
  132.  
  133. * When using numbered backup files, setting environment variable
  134.   VERSION_WIDTH now allows to use left zero padding (ie file.~001~).
  135.   (Patch by Chris F.A. Johnson <bq933@torfree.net>)
  136.  
  137. * --braces-on-if-line (-br) caused a '{' brace on the same line as a '}'
  138.   not to be put automatically on the next line, as it should because
  139.   the following { block } is not related to the previous { block } in
  140.   any way.
  141.  
  142. * Unpaired braces in `#if ..{.. #else/#elif ..{.. #endif }' constructs
  143.   was broken for #elif and when there were spaces after the #.
  144.  
  145. * Spelling, typo and general little improvements of indent.texinfo.
  146.   Now using Texinfo 4.0 markup.
  147.   (Patch by Kragen Sittler <sittler@day.erim-int.com>)
  148.  
  149. Release notes for GNU indent version 2.2.3, October 1999
  150.  
  151. * Fixed bit-fields with types other then `int' (no type still won't work).
  152.   Fixed support for public:, private: and protected: labels.
  153.  
  154. * Forgot to include the indent.dsp file in 2.2.2 (win32)
  155.  
  156. Release notes for GNU indent version 2.2.2, September 1999
  157.  
  158. * Added support for win32 (need VC++)
  159.  
  160. * Indent was sometimes adding a blank line at the top of an indented
  161.   file when indenting multiple files at once.  This bug has been fixed.
  162.  
  163. Release notes for GNU indent version 2.2.1, September 1999
  164.  
  165. * Indent got confused when a function declaration contained an enum
  166.   and did not contain a colon before using a '{' inside the function.
  167.  
  168.   enum foobar        <-- returns enum
  169.   func (enum foobar)    <-- or uses an enum as parameter
  170.   {
  171.     if (1)
  172.       {            <-- uses '{' before any ';' was used
  173.        func (1);}    <-- fails here
  174.        ... etc.
  175.  
  176. * A new option to stop `make' from rebuilding your whole project
  177.   after running `indent':
  178.  
  179.   -pmt, --preserve-mtime :
  180.      Preserve modification time on output files.
  181.  
  182. * Backup files now keep the same modification time as the
  183.   original.
  184.  
  185. * New -c++, --c-plus-plus option to allow better C++ formatting:
  186.   Recognizes C++ keywords, including the GNU extension operators <?= and >?=.
  187.   (Patch by Malekith <malekith@topnet.pl>)
  188.   Note: In general C++ still does NOT work!
  189.  
  190. * EBCDIC charset support for BS2000/POSIX (Siemens mainframe OS).
  191.   Contributed by <Martin.Kraemer@MchP.Siemens.De>.
  192.  
  193. Release notes for GNU indent version 2.2.0, July 1999
  194.  
  195. * Indent was detecting `const' errornous as function qualifier
  196.   in some cases. Resulting in
  197.  
  198.   void foo(fmt)
  199.    constchar *fmt;
  200.   {
  201.   }
  202.  
  203. * Compiles again with old K&R compilers.
  204.  
  205. * The `GetText' macros `N_' and `_' do not get a space appended anymore.
  206.  
  207. Release notes for GNU indent version 2.1, June 1999
  208.  
  209. * Merged in the changes made by Joseph Arceneaux from 1.9.1 -> 2.0.
  210.   Thus: 1.10.0 == 1.9.1 + Carlo's patches
  211.         2.0    == 1.9.1 + Joseph's patches
  212.     2.1.0  == 1.9.1 + Joseph's patches + Carlo's patches.
  213.   Below you can find the release notes of 2.0, which thus also apply to 2.1:
  214.   The maintenance is now officially transfered to Carlo Wood.
  215.  
  216. * GNU indent is now a lot more precise in honouring the --line-lengthN
  217.   option: It now joins lines when they fit on one line, and it won't
  218.   produce lines that are longer then the specified line length anymore
  219.   (except when no reasonable break point was found).
  220.  
  221. * Two new options to accommodate breaking long lines:
  222.   -hnl, --honour-newlines :
  223.      Prefer to break long lines at positions where the lines were broken
  224.      in the input file.
  225.   -nhnl, --ignore-newlines:
  226.      Don't prefer that.
  227.  
  228.   -bbo, --break-before-boolean-operator :
  229.      Prefer to break long lines before the boolean operators && and ||.
  230.   -nbbo, --break-after-boolean-operator :
  231.      Prefer to break long lines after the boolean operators && and ||.
  232.  
  233. * The default is now not to indent the braces of struct, union and enum.
  234.   A new option -sbiN or --struct-brace-indentationN allows to indent it
  235.   nevertheless.
  236.    
  237. Release notes for GNU indent version 2.0, November 1998 
  238.  
  239. * indent withstands the U. Wisconsin fuzz test. (See
  240.   http://www.cs.wisc.edu/Dienst/UI/2.0/Describe/ncstrl.uwmadison/CS-TR-95-1268
  241.   for details.)
  242.  
  243. * indent compiles with gcc -Wall and MSVC++ with no warnings.
  244.  
  245. * C++ code is handled to a great extent.  There is no special switch
  246.   or option. However, there are still several cases which are not
  247.   handled as well as they should be, and there are no options
  248.   controlling C++ formatting specifically.
  249.  
  250.   There is only one case I'm aware of in which the output of indent
  251.   breaks compilation;  this is nested templates such as:
  252.  
  253.     Aaa<int, Bbb<int> > anotherAB;
  254.  
  255.   are transformed into:
  256.  
  257.     Aaa < int, Bbb < int >>anotherAB;
  258.  
  259.   which is problematic for some compilers.  This is, in my opinion,
  260.   the fault of the incredibly brain-dead design of C++, and it's not
  261.   clear when or if indent will deal properly with this example.
  262.  
  263. * Wide strings and characters are now handled.
  264.  
  265. * The manual page, indent.1, has been removed from the distribution
  266.   because it is not supported and is seriously out of date (it
  267.   corresponds to indent 1.4).
  268.  
  269. * The "-bbb" option, which forces blanklines before boxed comments,
  270.   has been re-instated.
  271.  
  272. * Trailing spaces are removed from output.
  273.  
  274. * Line-breaking behaviour has been improved.
  275.  
  276. * The troff option has been removed.
  277.  
  278. * You may now put either C ("/* ... */") or C++ ("// ...") comments in
  279.   the indent profile.  Options within comments are ignored.
  280.  
  281. * The K&R style of leaving procedure names on the same line as their
  282.   type is now better supported (the option "-psl").
  283.  
  284. * The "-l" option now works more consistently.  This may change some
  285.   behaviour by breaking lines where they were not broken before.
  286.   Specifying an argument of "0" will turn off this option.
  287.  
  288. * The unused options "-ps" and "-nps" were removed.
  289.  
  290. * When `indent' completes its work successfully, it exits with a value
  291.   of 0.  Otherwise, one of the following values is returned:
  292.  
  293.   1 : This means `indent' was incorrectly invoked.
  294.   2 : Errors occurred during formatting, but processing continued.
  295.   3 : An unrecoverable error occured during the processing of an input
  296.       file.  If there are more input files, indent will proceed to
  297.       process them, but will return the error value 3.
  298.   4 : A serious internal error occured.  All processing is terminated.
  299.   5 : A system error during processing occurred.  In this case,
  300.      `indent' terminates.
  301.  
  302. Release notes for GNU indent version 1.10, May 1999.
  303.  
  304. * New maintainer.
  305.   New build environment, using automake now.
  306.   VMS support is removed (sorry).
  307.  
  308. * Many bug fixes - if you had problems before, try this version!
  309.  
  310. * New options have been added:
  311.     "-bls" ("--braces-after-struct-decl-line")
  312.     "-brs" ("--braces-on-struct-decl-line")
  313.     "-cbiN" ("--case-brace-indentationN")
  314.     "-piN" ("--paren-indentationN")
  315.  
  316. * Generated and thus up to date man page (indent.1).
  317.  
  318. Release notes for GNU indent version 1.9.
  319.  
  320. * All reported bugs have been fixed.
  321.  
  322. * A new option "-lc" ("--comment-line-length") was added.
  323.  
  324. * Please read the section "BUG REPORTS" in the README file.
  325.  
  326. * Unless "interesting" bugs appear, this will be the last release of
  327.   indent version 1.  The next release planned is version 2, which will
  328.   (hopefully) integrate support for C++, and possibly Objective C.
  329.   Additionally, a couple more OS's may be supported.
  330.  
  331. * A volunteer is now working on the `review' program, which examines C
  332.   code and produces the options that GNU `indent' would use to produce
  333.   code in that style.
  334.  
  335. Release Notes for GNU indent version 1.8.
  336.  
  337. * VMS and MS-DOS are now supported.  Thanks to MEHRDAD@glum.dev.cf.ac.uk
  338.   and hnyman@lesti.hut.fi for their contributions.
  339.  
  340.   Please note that I have no way of testing this code, and with slight
  341.   modifications, have installed it "as is".
  342.  
  343.   Also, note that these systems do not use `configure'.  See the file
  344.   VMS-README for details of the VMS installation.  For the MS-DOS
  345.   version, it is expected that the compiler will recognize the define
  346.   __MSDOS__ as being set.
  347.  
  348. * C++ comments are now recognized.  More C++ support will be
  349.   forthcoming, possibly along with support for Objective C.
  350.  
  351. * Formatting can be disabled for sections of code by placing that code
  352.   between lines containing the comments /* *INDENT-OFF* */ and
  353.   /* *INDENT-ON* */ (this also works in C++ comments).  See the info
  354.   node "Disabling Formatting" for more info.
  355.  
  356. * The processing of comments has been changed.  See the info node on
  357.   "Comments" for a description.
  358.  
  359. * The default (i.e., GNU) behaviour of struct handling has been
  360.   slightly changed.
  361.  
  362. * All reported bugs have been fixed.
  363.  
  364.  
  365. Release Notes for GNU indent version 1.7.
  366.  
  367. * All reported bugs have been fixed, except some of those dealing with
  368.   comments.  I have completely rewritten the comment handling code in
  369.   indent, but since this produces rather different comment formats
  370.   (mostly, it makes several comment-related options actually work) I
  371.   am waiting for the next release of indent to install this.
  372.  
  373.   To see what the differences in the comment handling will be, compare
  374.   the file `comments.texinfo' to the section on comments in the info
  375.   node for indent.
  376.  
  377.   It is possible that I have lost some bug reports, as some of my mail
  378.   falls into a crack between two machines.  In the future, please be
  379.   sure to use the address "bug-gnu-utils@prep.ai.mit.edu".
  380.  
  381. * All errors and warnings are output on the standard error stream,
  382.   and conform to the GNU error message format.
  383.  
  384. * There is now more support for small (i.e., 16-bit) machines.
  385.  
  386. * There have been slight changes to the default behaviour, namely:
  387.  
  388.   - Column 1 comments are not formatted.
  389.  
  390.   - Preprocessor spaces are removed.
  391.  
  392. * When "-lps" is specified, whitespace preceding the '#' character is
  393.   left untouched, as well as following whitespace.
  394.  
  395. * When the tabsize is specified as 1 or 0 (e.g., "-ts 0"), spaces are
  396.   used instead of tabs.  There may be bugs in this behaviour, but they
  397.   should vanish with the new comment code.
  398.  
  399.  
  400. Release Notes for GNU indent version 1.6.
  401.  
  402. * All reported bugs have been fixed.
  403.  
  404. * The makefiles have been, hopefully, improved (see the file `README'
  405.   for installation procedure).  Essentially, it is sufficent to type
  406.   "make" to build indent.  `indent' is distributed with `configure'
  407.   just as other GNU software.  Thus, in conformance with the GNU
  408.   standards, "configure; make" should function properly and `indent'
  409.   should fit properly in a GNU software tree.  However, it is my hope
  410.   that for most users, "make" is all they will have to type.
  411.  
  412.  
  413. Release Notes for GNU indent version 1.5.
  414.  
  415. * All reported bugs (and some unreported ones) have been fixed.
  416.  
  417. * The default behaviour of `indent' has changed slightly to be more
  418.   compatible with Emacs' C-mode.  In particular, where version 1.4
  419.   produced code looking like:
  420.  
  421.   struct token_data
  422.   {
  423.     enum token_data_type type;
  424.     union
  425.     {
  426.       struct
  427.       {
  428.     char *text;
  429.       }
  430.     u_t;
  431.     }
  432.       u;
  433.   };
  434.  
  435.   version 1.5 now generates the following:
  436.  
  437.   struct token_data
  438.   {
  439.     enum token_data_type type;
  440.     union
  441.       {
  442.     struct
  443.       {
  444.         char *text;
  445.       }
  446.     u_t;
  447.       }
  448.     u;
  449.   };
  450.  
  451. * There is a new option, "-lps" ("--leave-preprocessor-space") which
  452.   causes `indent' to leave the space between the `#' and the command
  453.   on preprocessor lines.
  454.  
  455. * `indent' now understands spaces between options and their arguments.
  456.   It is thus now possible to type: "indent -ip 4 latex.c"
  457.   Such spaces are also understood in a profile.
  458.  
  459. * indent 1.5 uses a configuration script generated by autoconf.  It
  460.   examines the system to produce a host-dependent makefile. This has
  461.   changed little with regard to building indent;  typing "make" will
  462.   build `indent'.  See the file "README" for details of this process.
  463.  
  464. * The file "indent.1" is a man document for indent 1.4 sent to me by
  465.   vogel@c-17igp.wpafb.af.mil.  The GNU project uses texinfo for its
  466.   documentation system, so this man page will remain officially
  467.   unsupported.  However, I will continue to distribute it as long as it
  468.   appears reasonably up to date.
  469.  
  470. * Thanks to the folks that sent me patches.
  471.  
  472.  
  473. Release Notes for GNU indent version 1.4.
  474.  
  475. Essentially, this version fixes bugs in version 1.3.
  476.  
  477.  
  478.  
  479.  
  480.  
  481. Release Notes for GNU indent version 1.3.  For more details, read the
  482. manual.
  483.  
  484.  
  485. * All reported bugs have been fixed.
  486.  
  487.  
  488. * The manual has been upgraded somewhat.
  489.  
  490.  
  491. * Command line syntax has changed with regard to input and output files.
  492.   The command:
  493.  
  494.           indent *.c
  495.  
  496.   for each file iguana.c, will indent iguana.c into iguana.c, after
  497.   first making a backup copy.
  498.  
  499.           indent liver_oil.c -o gullet.c
  500.  
  501.           cat liver_oil.c | indent -o gullet.c
  502.  
  503.           indent liver_iol.c -st > gullet.c
  504.  
  505.   Each of the above will indent "liver_oil.c" into "gullet.c".  The
  506.   "-st" ("--standard-output") option can only be used when the
  507.   standard input, or only a single input file is specified.
  508.  
  509.   It is also possible to use the standard input by specifying the single
  510.   filename "-" on the command line.  In this case, no other files may
  511.   be specified.
  512.  
  513.  
  514. * indent now makes GNU-style backup files.
  515.  
  516.   This behaviour is controlled by two environment variables,
  517.   VERSION_CONTROL and SIMPLE_BACKUP_SUFFIX.
  518.  
  519.   VERSION_CONTROL determines what kinds of backups are made.  If it's
  520.   value is "numbered", then the first modification of some file
  521.   "eraserhead.c" will yield a backup file "eraserhead.c.~1~", the
  522.   second modification will yield "eraserhead.c.~2~", and so on.  It
  523.   does not matter if the version numbers are not a sequence;  the next
  524.   version will be one greater than the highest in that directory.
  525.  
  526.   If the value of VERSION_CONTROL is "numbered_existing", then such
  527.   numbered backups will be made if there are already numbered backup
  528.   versions of the file.  Otherwise, the backup name will be that of
  529.   the original file with "~" (tilde) appended.  E.g., "eraserhead.c~".
  530.  
  531.   If the value of VERSION_CONTROL is "simple", then the backup name
  532.   will be that of the original file with "~" appended, regardless of
  533.   whether or not there exist numbered versions in the directory.
  534.  
  535.   For simple backups, the value of SIMPLE_BACKUP_SUFFIX will be used
  536.   rather than "~" if it is set.
  537.  
  538.   If VERSION_CONTROL is unset, "numbered_existing" is assumed.  For
  539.   lisp lovers, "nil" is equivalent to "numbered_existing" and "t" is
  540.   equivalent to "numbered".
  541.  
  542.   Finally, if VERSION_CONTROL is "none" or "never", backups are not
  543.   made.  I suggest you avoid this behaviour.
  544.  
  545.   Note also that backup files are made in the directory of the source
  546.   file, not the current directory (where indent was invoked).
  547.  
  548.  
  549. * Only one indent profile is read.  indent searches first for a
  550.   profile in the current directory and reads that if found.
  551.   Otherwise, indent looks for a profil in the home directory.
  552.  
  553.  
  554. * "-nip" is now handled.  This is equivalent to "-ip0".
  555.  
  556.  
  557. * The long name for "-bs" has been changed from "--Bill_Shannon" to
  558. "--blank_after_sizeof".
  559.  
  560.  
  561. Release notes for GNU indent version 1.7
  562.  
  563. The default style of indent is now the GNU style.  The option "-gnu"
  564. is still recognized.  To obtain the original indent default, use
  565. "-orig".  It is possible to obtain the original defaults by compiling
  566. args.c with -DBERKELEY_DEFAULTS.
  567.  
  568. Long options are now handled, prefaced by either "+" or "--".
  569.  
  570. A new option, "-ts", allows specification of tab sizes.
  571.  
  572. All reported bugs have been fixed.
  573.  
  574. The man format of documentation is no longer included.  indent.texinfo
  575. is the official document, in accordance with GNU standards.
  576. Investigate the program "texi2roff" for generating a MAN page.
  577.